/*
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/*
 * GlobalInfoJavadoc.java
 * Copyright (C) 2006-2012,2015 University of Waikato, Hamilton, New Zealand
 */

package weka.core;

import java.lang.reflect.Method;

/**
 * Generates Javadoc comments from the class's globalInfo method. Can
 * automatically update the comments if they're surrounded by the
 * GLOBALINFO_STARTTAG and GLOBALINFO_ENDTAG (the indention is determined via
 * the GLOBALINFO_STARTTAG). <br>
 * <br>
 * 
 * <!-- options-start --> Valid options are: <br>
 * 
 * <pre>
 *  -W &lt;classname&gt;
 *  The class to load.
 * </pre>
 * 
 * <pre>
 *  -nostars
 *  Suppresses the '*' in the Javadoc.
 * </pre>
 * 
 * <pre>
 *  -dir &lt;dir&gt;
 *  The directory above the package hierarchy of the class.
 * </pre>
 * 
 * <pre>
 *  -silent
 *  Suppresses printing in the console.
 * </pre>
 * 
 * <!-- options-end -->
 * 
 * @author fracpete (fracpete at waikato dot ac dot nz)
 * @version $Revision$
 * @see #GLOBALINFO_METHOD
 * @see #GLOBALINFO_STARTTAG
 * @see #GLOBALINFO_ENDTAG
 */
public class GlobalInfoJavadoc extends Javadoc {

    /** the globalInfo method name */
    public final static String GLOBALINFO_METHOD = "globalInfo";

    /** the start comment tag for inserting the generated Javadoc */
    public final static String GLOBALINFO_STARTTAG = "<!-- globalinfo-start -->";

    /** the end comment tag for inserting the generated Javadoc */
    public final static String GLOBALINFO_ENDTAG = "<!-- globalinfo-end -->";

    /**
     * default constructor
     */
    public GlobalInfoJavadoc() {
        super();

        m_StartTag = new String[1];
        m_EndTag = new String[1];
        m_StartTag[0] = GLOBALINFO_STARTTAG;
        m_EndTag[0] = GLOBALINFO_ENDTAG;
    }

    /**
     * generates and returns the Javadoc for the specified start/end tag pair.
     * 
     * @param index the index in the start/end tag array
     * @return the generated Javadoc
     * @throws Exception in case the generation fails
     */
    protected String generateJavadoc(int index) throws Exception {
        String result;
        Method method;

        result = "";

        if (index == 0) {
            if (!canInstantiateClass())
                return result;

            try {
                method = getInstance().getClass().getMethod(GLOBALINFO_METHOD, (Class[]) null);
            } catch (Exception e) {
                // no method "globalInfo"
                return result;
            }

            // retrieve global info
            result = toHTML((String) method.invoke(getInstance(), (Object[]) null));
            result = result.trim() + "\n<br><br>\n";

            // stars?
            if (getUseStars())
                result = indent(result, 1, "* ");
        }

        return result;
    }

    /**
     * Parses the given commandline parameters and generates the Javadoc.
     * 
     * @param args the commandline parameters for the object
     */
    public static void main(String[] args) {
        runJavadoc(new GlobalInfoJavadoc(), args);
    }
}
